home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ktfm_200.zip / KTFLEA.DOC < prev    next >
Text File  |  1992-12-08  |  21KB  |  493 lines
  1.                           KT-FleaMarket v2.00
  2.                 Copyright(c) 1992 by Kelsey Technologies
  3.                           All Rights Reserved.
  4.                    ---------------------------------
  5.                           Kelsey Technologies
  6.                               P.O. Box 288
  7.                          St. Mary's, GA  31558
  8.                          Phone: (912) 882-0533
  9.                           BBS: (912) 882-3588
  10.  
  11.  
  12. DESCRIPTION
  13. -----------
  14.     KT-FleaMarket is a BBS Door program which will provide your users
  15.     with a complete, full featured Advertisement System.  KT-FleaMarket
  16.     will support unlimited categories, up to 1 billion Ads, COM1-4,
  17.     non-standard IRQ's, DOOR.SYS, DORINFOx.DEF and High Speed Modems.
  18.  
  19.     KT-FleaMarket now supports 'Attached Files'.  Your users can leave
  20.     an ad and then upload an attached file using Zmodem, Ymodem,
  21.     Ymodem-G, Xmodem, and Xmodem-1k (without the need for DSZ).  Others
  22.     can download the attached file while viewing the ad using the same
  23.     protocols.  Whether you allow Attached Files or Not is up to you.
  24.  
  25.     The Validation Option allows you to automatically set all NEW ads to
  26.     'invalidated'.  After the New ad is left, the only person who may
  27.     view this ad is the SysOp.  The Validation Option can serve two
  28.     purposes. One: you could 'sell' ad space on your system, or Two:
  29.     you'll be able to view each ad before it's released to prevent
  30.     unethical, immoral, nasty language, etc.  If you 'turn off' the
  31.     validation option, all ads are immediately released for public
  32.     viewing.
  33.  
  34.     KT-FleaMarket v2.0 uses Real-Time File and Record Locking to provide
  35.     the safest multi-user environment available which can theoretically
  36.     support an unlimited number of concurrent users.
  37.  
  38. FILES:
  39. ------
  40.     This is a VERY BASIC description of each file.  Files requiring
  41.     more explicit information will be addressed later on in the
  42.     document.
  43.  
  44.     You should have the following files:
  45.  
  46.         README   1ST      <-- Instructions on UPGRADING to version 2.0
  47.         KTFLEA   DOC      <-- The file you are reading now.
  48.         KTFLEA   EXE      <-- The KT-FleaMarket Executable File.
  49.         KTFLEA   CAT      <-- A sample Category file.
  50.         KTFLEA   KEY      <-- Registration Key File.
  51.         USERHELP TXT      <-- Help file for the KT-FleaMarket System.
  52.                               You are welcome to Modify this file as
  53.                               needed.  Also, you may want to place this
  54.                               file in an archived form for your users to
  55.                               download.
  56.         KTFLEA   DBF      <-- KT-FleaMarket Main Database File.
  57.         KTFLEA   NTX      <-- KT-FleaMarket Main Index File.
  58.         LOCAL    BAT      <-- Batch file for running KT-FleaMarket in
  59.                               LOCAL Mode.
  60.         PURGE    BAT      <-- Batch file for Purging Old Records from
  61.                               the Database.
  62.         PACK     BAT      <-- Batch file for Removing Deleted Records
  63.                               from the Database.
  64.         SETUP    BAT      <-- Batch file for Setting-Up KT-FleaMarket.
  65.         MAKETEXT BAT      <-- Batch file for making the KTFM_ADS.TXT
  66.                               file.
  67.         SAMPLBAT DOC      <-- Sample Batch Files
  68.         KTFM200  DBF      <-- Used by the UPGRADE utility for Upgrading
  69.                               to v2.0 from a previous version of
  70.                               KT-FleaMarket.
  71.  
  72.  
  73.     These files may be created while using KT-FleaMarket:
  74.  
  75.         KTFLEA   CFG      <-- Configuration file containing the Attached
  76.                               Files Directory
  77.         KTFM_ADS TXT      <-- Text file of ALL the Validated Ads in your
  78.                               database. This file should be archived for
  79.                               downloading from within the door.
  80.  
  81.  
  82. UPGRADING FROM A PREVIOUS VERSION
  83. ---------------------------------
  84.      If you're currently using KT-FleaMarket prior to v2.0 you'll need
  85.      to upgrade your Database Files to be compatable with the new
  86.      version.
  87.  
  88.         PLEASE PRINT THE README.1ST FILE FOR DETAILED INSTRUCTIONS
  89.         BEFORE PERFORMING THE UPGRADE!
  90.  
  91.  
  92. LOCAL TESTING
  93. -------------
  94.      When I download a new DOOR, the first thing I want to do is try it
  95.      out.  Unfortunately, a lot of DOORS out there require extensive
  96.      setup and configuration to run locally.  Not mine!
  97.  
  98.         Type: KTFLEA LOCAL
  99.  
  100.      This will start KT-FleaMarket in LOCAL mode and allow you to add,
  101.      edit, delete, etc. and test out the system. I've included a batch file 
  102.      called LOCAL.bat for your convenience.
  103.  
  104.      NOTE: To fully enjoy the system, you should read the docs.  There
  105.      are many features which you'll not notice in local mode.  There are
  106.      a few features that you can only use in Local Mode...Please Read On
  107.      When You're Done Playing....have fun!
  108.  
  109. SETUP:
  110. ------
  111.  
  112.      You should first decide on three items:
  113.  
  114.         What Categories will you offer your users?
  115.                 You can have an unlimited number of Categories but the
  116.                 ones I've provided in the KTFLEA.CAT file are probably
  117.                 the most you'll need.  I'm not saying however that you
  118.                 should use only mine....please be creative!  Let me know
  119.                 some of the unique Categories you've come up with.
  120.  
  121.  
  122.         Will you permit files to be attached to the Ads?
  123.                 This is pretty self explanatory. Either you'll allow it
  124.                 or not.
  125.  
  126.         Will you require Validation of New Ads?
  127.                 If you'll want all New Ads to be Validated before
  128.                 release to the public, then the answer here would be
  129.                 Yes.  KT-FleaMarket allows you to run the system as
  130.                 either Open (meaning new ads are automatically released)
  131.                 or Closed (meaning new ads are not released until YOU
  132.                 validate them).
  133.  
  134.      CATEGORIES:
  135.      -----------
  136.      In the file KTFLEA.CAT you'll find some examples of Categories
  137.      Similar to those you'd find in the local newspaper (and a few of my
  138.      own).
  139.  
  140.      ╔════════════════════════════════════════════════════════════╗
  141.      ║  NOTES: THE FIRST LINE MUST ALWAYS BE:  ALL CATEGORIES;ALL ║
  142.      ║                                                            ║
  143.      ║         DON'T PUT ANY OTHER TEXT OR NOTES IN THE CATEGORY  ║
  144.      ║         FILE EXCEPT YOUR CATEGORIES.                       ║
  145.      ╚════════════════════════════════════════════════════════════╝
  146.  
  147.      The structure of this file goes like this:
  148.  
  149.         Category Description;CATEGORY NAME
  150.  
  151.      The Category Description may be up to 65 characters and the
  152.      CATEGORY NAME may be up to 20 characters with a semi-colon (;) as a
  153.      separator (can you say that three times real fast?).
  154.  
  155.         Local BBS Ads;LOCAL BBS ADS
  156.         Garage Sales;GARAGE SALE
  157.         Dog, Cat, Bird, and Mouse Grooming;PET GROOMING
  158.  
  159.      Get the idea? The CATEGORY NAME must be in all CAPS.  Don't put any
  160.      spaces between the Description, the Semi-Colon, and the Name.
  161.  
  162.         ADDING/DELETING CATEGORIES:
  163.         ----------------------------
  164.         Feel free to use your favorite editor to sort this listing of
  165.         Categories.  Makes for a better presentation to the user.
  166.  
  167.         If you wish to REMOVE a Category from the list, ensure you've
  168.         deleted all Ads under that Category from the Database First (or
  169.         use the KTFMEditor which is described below).
  170.  
  171.         If you want to ADD a Category, you don't need to do a thing
  172.         except put it in the KTFLEA.CAT file.  KT-FleaMarket will take
  173.         care of everything else.
  174.  
  175.  
  176.      ATTACHED FILES:
  177.      ---------------
  178.      If you'll be permitting Attached Files, you first must create a
  179.      directory to hold these files.  For instance, let's say your
  180.      KT-FleaMarket system will be in the directory C:\BBS\DOORS\KTFLEA.
  181.      You should create another directory under this one to hold the
  182.      Attached Files. C:\BBS\DOORS\KTFLEA\FILES\
  183.  
  184.      After you create the Attached Files Directory, run the SETUP
  185.      utility by issuing the command:
  186.  
  187.                 KTFLEA SETUP
  188.  
  189.      You'll be prompted to enter the directory which will contain the
  190.      Attached Files.  If you leave this field blank and enter nothing,
  191.      the Attached Files Option will be disabled.  If, on the other hand,
  192.      you enter a directory, the Attached Files Option will be enabled.
  193.  
  194.  
  195.      VALIDATION OPTION:
  196.      ------------------
  197.      The Validation Option is controlled throughout the command line as
  198.      most options are with my software (I feel it's easier than running
  199.      a setup or configure program each time you want to make a change).
  200.      More on the Validation Option in a minute.
  201.      SYNTAX ('The Batch File')
  202.      -------------------------
  203.      Basic Command Line:
  204.  
  205.         KTFLEA <bbstype> <userfile> </irq#> <CTSRTS> <VALIDATE>
  206.  
  207.      <bbstype> Is the BBS Software you are using.  This command goes
  208.      hand-in-hand with the <userfile> command.
  209.  
  210.         If your BBS can create a DOOR.SYS file, the command would be:
  211.  
  212.                 KTFLEA WILDCAT C:\BBS\NODE1\DOOR.SYS
  213.  
  214.         If your BBS can create a DORINFOx.DEF file, the command would
  215.         be:
  216.  
  217.                 KTFLEA RBBS C:\BBS\NODE1\DORINFOx.DEF
  218.  
  219.      You MUST specify which directory the <userfile> is in!
  220.  
  221.     ╒═════════════════════════════════════════════════════════════════╕
  222.     │BECAUSE YOU USE THE WILDCAT OR RBBS COMMAND DOESN'T MEAN YOU MUST│
  223.     │BE USING WILDCAT OR RBBS.  THIS IS ONLY A SWITCH TO TELL         │
  224.     │KT-FleaMarket HOW TO READ THE USER FILE.                         │
  225.     ╘═════════════════════════════════════════════════════════════════╛
  226.  
  227.     </irq#> (NON STANDARD IRQ's)
  228.     ----------------------------
  229.     If your COM port is set up to use a Non-Standard IRQ, you may place
  230.     the IRQ number preceded by a '/' as the third argument in the
  231.     command line.  You'll probably only need this feature if you're
  232.     using more than two COM ports.  For example, if your COM3 were set
  233.     to use IRQ 2 instead of the standard 3, you would place '/2' as the
  234.     third argument (i.e. KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS /2).
  235.  
  236.  
  237.     <CTSRTS> (HIGH SPEED MODEMS)
  238.     ----------------------------
  239.     If you're using a High Speed Modem (i.e. 9600 baud or higher),
  240.     you'll want to enable CTS/RTS Flow Control. To do this, add the
  241.     command CTSRTS.  For example:
  242.  
  243.                 (standard IRQ)
  244.                 KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS CTSRTS
  245.                                    or
  246.                 (non-standard IRQ)
  247.                 KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS /2 CTSRTS
  248.  
  249.     Just remember to put 'CTSRTS' after the <userfile> argument or the
  250.     <irq#> argument.
  251.  
  252.     <VALIDATE> (VALIDATION OPTION)
  253.     ------------------------------
  254.     If you wish to enable the Validation Option, add the command
  255.     VALIDATE. For example:
  256.  
  257.                 (standard IRQ, no CTSRTS disabled)
  258.                 KTUSBBS WILDCAT C:\BBS\NODE3\DOOR.SYS VALIDATE
  259.                                    or
  260.                 (non-standard IRQ, no CTSRTS disabled)
  261.                 KTFLEA WILDCAT C:\BBS\NODE3\DOOR.SYS /2 VALIDATE
  262.                                    or
  263.                 (non-standard IRQ, CTSRTS enabled)
  264.                 KTFLEA WILDCAT C:\BBS\NODE3\DOOR.SYS /2 CTSRTS VALIDATE
  265.  
  266.     Just remember to put 'VALIDATE' as the LAST command.
  267.  
  268.  
  269.     SAMPLE BBS BATCH FILES
  270.     ---------------------
  271.     See the file SAMPLBAT.DOC for additional samples.
  272.  
  273.  
  274. USERHELP.TXT
  275. ------------
  276. The file USERHELP.TXT may be edited as you wish.  This file provides
  277. help to the user while using the DOOR.  You may also wish to place this
  278. file in a download area so your users can read up on how the system
  279. works.
  280.  
  281. KT-FleaMarket was designed with the most Novice Users in mind.  They
  282. shouldn't need much help.
  283.  
  284.  
  285. MAINTENANCE (LOCAL MODE)
  286. ------------------------
  287.     There really isn't much maintenance involved with this system. It
  288.     pretty much takes care of itself.  However (always a however), if
  289.     you've enabled VALIDATION, you'll need to Validate the Un-Validated
  290.     Ads (does that make any sense? I didn't think so).
  291.  
  292.  
  293.         TO VALIDATE ADS:
  294.         ----------------
  295.         A few quick notes about Validating Ads and Local Mode...
  296.             While viewing Ads in the Detail Mode, there are several
  297.             options available (as seen on the last line in the display).
  298.             One of these Options is (V)alidate, but it's hidden. This
  299.             (V)alidate Option 'Toggles' the Validation Status of that
  300.             particular Ad.  You can tell whether the Ad is Validated or
  301.             Not by the words "Validated" or "!! NOT VALIDATED !!", which
  302.             appear right under the Category Name.  This "Validation
  303.             Status" is only visible while in Local Mode.
  304.  
  305.         To Validate Ads, start KT-FleaMarket in the local mode (KTFLEA
  306.         LOCAL) and Select ALL CATEGORIES.
  307.  
  308.         When the Main Menu appears, you'll notice an additional option
  309.         in Blue called [V]alidate Ads (this only appears in Local Mode).
  310.  
  311.         Selecting the Option [V]alidate Ads will filter out ALL Ads
  312.         which are marked as !!! NOT VALIDATED !!!.
  313.  
  314.         At this point, you would select the Option, [L]ist Ads (Detail),
  315.         and step through each "Un-Validated" Ad, changing the
  316.         "Validation Status" as you see fit.
  317.  
  318.         This probably sounds confusing but it's really quite easy as
  319.         you'll see when you try it.
  320.  
  321.  
  322.         privileges...
  323.         -------------
  324.         Being SysOp has it's privileges.  While using KT-FleaMarket in
  325.         Local Mode, the options (E)dit and (K)ill will
  326.         always be available in the Detail Screens.  While running as a
  327.         DOOR, these options will ONLY be available to the user who
  328.         placed it.  That way, Joe can't mess with Bob's Ads.  Who is Joe
  329.         and Bob?
  330.  
  331.         The hidden option (V)alidate will be available at all times
  332.         while in Local Mode also.
  333.  
  334.         Please see KTFMEditor later in this document.
  335.  
  336.  
  337.     Automatic Purge
  338.     ---------------
  339.     After time, Ads become obsolete.  Either the person moved, the item
  340.     sold, or a hurricane destroyed it.  Regardless, the users will be
  341.     lazy and probably won't delete their old Ads.  Not to fear!  You can
  342.     put out in a bulletin or in the USERHELP.TXT file that all ads over
  343.     120 days will be removed.  Now, make a monthly event (or weekly, or
  344.     daily, or hourly if you want) to purge Ads over 120 days.  Oh yea,
  345.     you need the command.....
  346.  
  347.         KTFLEA PURGE 120
  348.  
  349.     Simply replace the 120 above with what ever number of days old you
  350.     wish to remove.  NOTE: If anyone is using the system on another
  351.     node, the Purge Command will wait up to 10 Seconds to get an
  352.     Exclusive Lock on the Database.  If Exclusive Control can't be had,
  353.     the purge will not take place.  Just a little safety feature.
  354.  
  355.  
  356.     Removing Deleted Ads:
  357.     ---------------------
  358.     Well, OK, some of your users may actually delete their ads when they
  359.     no longer apply.  If this is the case, run the PACK command on a
  360.     regular basis to remove these deleted records.  The command is:
  361.  
  362.         KTFLEA PACK
  363.  
  364.     This command is useful if you don't have a need to ever Purge the
  365.     Database.  They both do the same thing, as far as removing Deleted
  366.     Records.  If you use the Purge Command, the Pack Command is
  367.     unnecessary.  NOTE: If anyone is using the system on another node,
  368.     the Pack Command will wait up to 10 Seconds to get an Exclusive
  369.     Lock on the Database.  If Exclusive Control can't be had, the Pack
  370.     will not take place.  Just another little safety feature.
  371.  
  372.     Making the Classified Ads File:
  373.     -------------------------------
  374.     An option within KT-FleaMarket is [D]ownload Ads List.  That's
  375.     great, but if there isn't one....well, nothing is going to happen.
  376.     To create the Classified Ads File, issue the command:
  377.  
  378.         KTFLEA MAKETEXT
  379.  
  380.     This will create a file called KTFM_ADS.TXT which contains all the
  381.     Validated Ads in the Database, sorted on Category.  You'll need to
  382.     archive this file and call it KTFM_ADS.ZIP/LZH/ARJ
  383.  
  384.     KT-FleaMarket will first look in the Attached Files Directory (if you've
  385.     enabled that feature), then in the current directory for a file
  386.     called KTFM_ADS which ends in either .ZIP, .LZH, or .ARJ.  In that
  387.     order.  I've included a batch file called MAKETEXT.BAT for your
  388.     convenience (Using PKZIP).
  389.  
  390.     KTFMEditor
  391.     ----------
  392.     If you'd like more control over the editing of the Database, call
  393.     our BBS and download KTFMED10.ZIP.  This is a full featured Database
  394.     Editor for use with KT-FleaMarket v2.0.  It makes the archive too
  395.     big to simply throw it in with the KT-FleaMarket System...sorry...
  396.  
  397.  
  398. WHAT THE USER NEEDS
  399. -------------------
  400.     At this time, KT-FleaMarket only supports ANSI users. We have plans
  401.     to support "non-ANSI" users in the future..but..this day in age, most
  402.     users have the ability to support ANSI and this shouldn't be too
  403.     much of a problem for you. Please leave us comments on this subject.
  404.  
  405.  
  406. WHAT THE USER CAN DO
  407. --------------------
  408.     Please look at the USERHELP.TXT file for option information.
  409.  
  410.  
  411. TECHNICAL STUFF
  412. ---------------
  413.   * You must, at a minimum, have the files and buffers set at:
  414.  
  415.                 FILES = 40
  416.                 BUFFERS = 30
  417.  
  418.   * KT-FleaMarket v2.0's EXE Load Image Size is 295k.
  419.  
  420.   * KT-FleaMarket uses interal Dynamic Overlays-  please don't try to
  421.     compress the EXE file with PKLite or LZE or any other EXE
  422.     Compression Program, it won't work.
  423.  
  424.   * KT-FleaMarket has a built-in VMM (Virtual Memory Manager).  The
  425.     system will use all available extended memory up to 8 Meg. If none
  426.     is available, it will resort to Disk Swapping in the current
  427.     directory.
  428.  
  429.   * KT-FleaMarket was developed in Clipper v5.01a.
  430.  
  431.  
  432. CREDITS
  433. -------
  434.     Thanks to Tammy, Kelsey, and Lindsey for their support over
  435.     the past six years.
  436.  
  437.     Some names may be used in this manual which are trademarks or
  438.     registered trademarks of their respective owners.
  439.  
  440.  
  441. REGISTRATION
  442. ------------
  443.     KT-FleaMarket is not public domain, but Shareware.  You are granted
  444.     a limited license to operate this program for a test period of 30
  445.     days. Completing this test period, if you decide to continue its
  446.     use, you must register.  The registration fee is $27.00. Georgia
  447.     residents add 6% sales tax.
  448.  
  449.     For more information on how to register, please print out the file
  450.     REGISTER.FRM.
  451.    ╔══════════════════════════════════════════════════════════════════╗
  452.    ║             !!! KT-FleaMarket IS NOT CRIPPLED !!!                ║
  453.    ║                                                                  ║
  454.    ║By registering KT-FleaMarket you will encourage myself and other  ║
  455.    ║shareware authors to continue to provide you with quality software║
  456.    ║at the most reasonable prices. After registration, your BBS name  ║
  457.    ║will appear on the opening and closing screens and remove that    ║
  458.    ║annoying delay and big bold message telling everyone that you     ║
  459.    ║haven't registered the software (whew, what a mouthful..) . Other ║
  460.    ║than that, you have in your hands a fully functional KT-FleaMarket║
  461.    ║system. I DON'T BELIEVE IN CRIPPLEWARE, HELP ME KEEP IT THAT WAY! ║
  462.    ╚══════════════════════════════════════════════════════════════════╝
  463.  
  464. COMMENTS PLEASE!
  465. ----------------
  466.     Please place the UNREGISTERED VERSION of this program in your
  467.     communications program download area for others to evaluate.  Your
  468.     comments on this program are most appreciated (and encouraged).
  469.     Please call our BBS and leave comments, the number is (912) 882-3588
  470.     1200-14400 / 24 hrs. Your comments could very well be what everyone
  471.     else wants also, please don't be shy!
  472.     
  473.     What does the future hold? You tell me!
  474.  
  475. DISCLAIMER/PROBLEMS/WARRANTY
  476. ----------------------------
  477.     This program is distributed as is. We guarantee that this program
  478.     and its associated files will do nothing more than take up disk
  479.     space on your computer!
  480.  
  481.     There is NO warranty!
  482.  
  483.     Should something go wrong, a file will be created in the
  484.     KT-FleaMarket directory called ERROR.LOG. This will be very helpful
  485.     to us to determine what went wrong, should you have any problems.
  486.  
  487.     Please communicate any problems with us through the Kelsey
  488.     Technologies Support BBS at (912) 882-3588.  Any problems received
  489.     will be treated as high priority.
  490.  
  491.  
  492.  
  493.